<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="utf-8">
  <meta http-equiv="X-UA-Compatible" content="IE=edge">
  <meta name="viewport" content="width=device-width, height=device-height, initial-scale=1, user-scalable=no">
  <meta name="description" content="API docs for the CreatorModel class from the models library, for the Dart programming language.">
  <title>CreatorModel class - models library - Dart API</title>


  
  <link rel="preconnect" href="https://fonts.gstatic.com">
  <link href="https://fonts.googleapis.com/css2?family=Roboto+Mono:ital,wght@0,300;0,400;0,500;0,700;1,400&display=swap" rel="stylesheet">
  <link href="https://fonts.googleapis.com/css2?family=Material+Symbols+Outlined:opsz,wght,FILL,GRAD@48,400,0,0" rel="stylesheet">
  
  <link rel="stylesheet" href="../static-assets/github.css?v1">
  <link rel="stylesheet" href="../static-assets/styles.css?v1">
  <link rel="icon" href="../static-assets/favicon.png?v1">

  
</head>


<body data-base-href="../" data-using-base-href="false" class="light-theme">

<div id="overlay-under-drawer"></div>

<header id="title">
  <span id="sidenav-left-toggle" class="material-symbols-outlined" role="button" tabindex="0">menu</span>
  <ol class="breadcrumbs gt-separated dark hidden-xs">
    <li><a href="../index.html">yuuna</a></li>
    <li><a href="../models/models-library.html">models</a></li>
    <li class="self-crumb">CreatorModel class</li>
  </ol>
  <div class="self-name">CreatorModel</div>
  <form class="search navbar-right" role="search">
    <input type="text" id="search-box" autocomplete="off" disabled class="form-control typeahead" placeholder="Loading search...">
  </form>
  <div class="toggle" id="theme-button">
    <label for="theme">
      <input type="checkbox" id="theme" value="light-theme">
      <span id="dark-theme-button" class="material-symbols-outlined">
        brightness_4
      </span>
      <span id="light-theme-button" class="material-symbols-outlined">
        brightness_5
      </span>
    </label>
  </div>
</header>
<main>

  <div id="dartdoc-main-content" class="main-content">
      <div>
<h1><span class="kind-class">CreatorModel</span> class 
 
</h1></div>

    
<section class="desc markdown">
  <p>A scoped model for parameters that affect the card creator. RiverPod is
used for global state management across multiple layers, and is useful for
showing the creator and sharing code across the entire application.</p>
</section>


    <section>
      <dl class="dl-horizontal">
        

        
        
  <dt>Mixed in types</dt>
  <dd>
    <ul class="comma-separated clazz-relationships">
        <li><a href="https://api.flutter.dev/flutter/foundation/ChangeNotifier-class.html">ChangeNotifier</a></li>
    </ul>
  </dd>



        


      </dl>
    </section>

    
  <section class="summary offset-anchor" id="constructors">
    <h2>Constructors</h2>

    <dl class="constructor-summary-list">
        <dt id="CreatorModel" class="callable">
          <span class="name"><a href="../models/CreatorModel/CreatorModel.html">CreatorModel</a></span><span class="signature">()</span>
        </dt>
        <dd>
          
        </dd>
    </dl>
  </section>

    <section class="summary offset-anchor" id="instance-properties">
      <h2>Properties</h2>

      <dl class="properties">
        <dt id="controllersByField" class="property">
  <span class="name"><a href="../models/CreatorModel/controllersByField.html">controllersByField</a></span>
  <span class="signature">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/Map-class.html">Map</a><span class="signature">&lt;<wbr><span class="type-parameter"><a href="../creator/Field-class.html">Field</a></span>, <span class="type-parameter"><a href="https://api.flutter.dev/flutter/widgets/TextEditingController-class.html">TextEditingController</a></span>&gt;</span></span> 

</dt>
<dd>
  A map of <code>TextEditingController</code> for every creator field.
  <div class="features"><span class="feature">read-only</span></div>

</dd>

        <dt id="hashCode" class="property inherited">
  <span class="name"><a href="https://api.flutter.dev/flutter/dart-core/Object/hashCode.html">hashCode</a></span>
  <span class="signature">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/int-class.html">int</a></span> 

</dt>
<dd class="inherited">
  The hash code for this object.
  <div class="features"><span class="feature">read-only</span><span class="feature">inherited</span></div>

</dd>

        <dt id="hasListeners" class="property inherited">
  <span class="name"><a href="https://api.flutter.dev/flutter/foundation/ChangeNotifier/hasListeners.html">hasListeners</a></span>
  <span class="signature">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/bool-class.html">bool</a></span> 

</dt>
<dd class="inherited">
  Whether any listeners are currently registered.
  <div class="features"><span class="feature">read-only</span><span class="feature">inherited</span></div>

</dd>

        <dt id="runtimeType" class="property inherited">
  <span class="name"><a href="https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html">runtimeType</a></span>
  <span class="signature">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/Type-class.html">Type</a></span> 

</dt>
<dd class="inherited">
  A representation of the runtime type of the object.
  <div class="features"><span class="feature">read-only</span><span class="feature">inherited</span></div>

</dd>

        <dt id="scrollController" class="property">
  <span class="name"><a href="../models/CreatorModel/scrollController.html">scrollController</a></span>
  <span class="signature">&#8594; <a href="https://api.flutter.dev/flutter/widgets/ScrollController-class.html">ScrollController</a></span> 

</dt>
<dd>
  Scroll controller for the Creator page.
  <div class="features"><span class="feature">final</span></div>

</dd>

      </dl>
    </section>

    
  <section
      class="summary offset-anchor"
      id="instance-methods">
    <h2>Methods</h2>
    <dl class="callables">
        <dt id="addListener" class="callable inherited">
  <span class="name"><a href="https://api.flutter.dev/flutter/foundation/ChangeNotifier/addListener.html">addListener</a></span><span class="signature">(<wbr><span class="parameter" id="addListener-param-listener"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-ui/VoidCallback.html">VoidCallback</a></span> <span class="parameter-name">listener</span></span>)
    <span class="returntype parameter">&#8594; void</span>
  </span>
  

</dt>
<dd class="inherited">
  Register a closure to be called when the object changes.
  <div class="features"><span class="feature">inherited</span></div>

</dd>

        <dt id="appendSentenceAndCloze" class="callable">
  <span class="name"><a href="../models/CreatorModel/appendSentenceAndCloze.html">appendSentenceAndCloze</a></span><span class="signature">(<wbr><span class="parameter" id="appendSentenceAndCloze-param-sentence"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/String-class.html">String</a></span> <span class="parameter-name">sentence</span></span>)
    <span class="returntype parameter">&#8594; void</span>
  </span>
  

</dt>
<dd>
  Append the appropriate fields for cloze compatibility.
  

</dd>

        <dt id="clearAll" class="callable">
  <span class="name"><a href="../models/CreatorModel/clearAll.html">clearAll</a></span><span class="signature">(<wbr><span class="parameter" id="clearAll-param-overrideLocks">{<span>required</span> <span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/bool-class.html">bool</a></span> <span class="parameter-name">overrideLocks</span>, </span><span class="parameter" id="clearAll-param-savedTags"><span>required</span> <span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/String-class.html">String</a></span> <span class="parameter-name">savedTags</span>}</span>)
    <span class="returntype parameter">&#8594; void</span>
  </span>
  

</dt>
<dd>
  Clear all fields and current context.
  

</dd>

        <dt id="clearField" class="callable">
  <span class="name"><a href="../models/CreatorModel/clearField.html">clearField</a></span><span class="signature">(<wbr><span class="parameter" id="clearField-param-field"><span class="type-annotation"><a href="../creator/Field-class.html">Field</a></span> <span class="parameter-name">field</span>, </span><span class="parameter" id="clearField-param-savedTags">{<span>required</span> <span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/String-class.html">String</a></span> <span class="parameter-name">savedTags</span>, </span><span class="parameter" id="clearField-param-overrideLocks"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/bool-class.html">bool</a></span> <span class="parameter-name">overrideLocks</span> = <span class="default-value">false</span>, </span><span class="parameter" id="clearField-param-notify"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/bool-class.html">bool</a></span> <span class="parameter-name">notify</span> = <span class="default-value">true</span>}</span>)
    <span class="returntype parameter">&#8594; void</span>
  </span>
  

</dt>
<dd>
  Clear a controller for a particular field.
  

</dd>

        <dt id="copyContext" class="callable">
  <span class="name"><a href="../models/CreatorModel/copyContext.html">copyContext</a></span><span class="signature">(<wbr><span class="parameter" id="copyContext-param-creatorFieldValues"><span class="type-annotation"><a href="../creator/CreatorFieldValues-class.html">CreatorFieldValues</a></span> <span class="parameter-name">creatorFieldValues</span></span>)
    <span class="returntype parameter">&#8594; void</span>
  </span>
  

</dt>
<dd>
  Clone the <a href="../creator/CreatorFieldValues-class.html">CreatorFieldValues</a>'s contents into the model.
  

</dd>

        <dt id="dispose" class="callable inherited">
  <span class="name"><a href="https://api.flutter.dev/flutter/foundation/ChangeNotifier/dispose.html">dispose</a></span><span class="signature">(<wbr>)
    <span class="returntype parameter">&#8594; void</span>
  </span>
  

</dt>
<dd class="inherited">
  Discards any resources used by the object. After this is called, the
object is not in a usable state and should be discarded (calls to
<a href="https://api.flutter.dev/flutter/foundation/ChangeNotifier/addListener.html">addListener</a> will throw after the object is disposed).
  <div class="features"><span class="feature">inherited</span></div>

</dd>

        <dt id="getExportDetails" class="callable">
  <span class="name"><a href="../models/CreatorModel/getExportDetails.html">getExportDetails</a></span><span class="signature">(<wbr><span class="parameter" id="getExportDetails-param-ref"><span class="type-annotation"><a href="https://pub.dev/documentation/flutter_riverpod/1.0.4/flutter_riverpod/WidgetRef-class.html">WidgetRef</a></span> <span class="parameter-name">ref</span></span>)
    <span class="returntype parameter">&#8594; <a href="../creator/CreatorFieldValues-class.html">CreatorFieldValues</a></span>
  </span>
  

</dt>
<dd>
  Get a snapshot of the relevant parameters of the model for card export.
  

</dd>

        <dt id="getFieldController" class="callable">
  <span class="name"><a href="../models/CreatorModel/getFieldController.html">getFieldController</a></span><span class="signature">(<wbr><span class="parameter" id="getFieldController-param-field"><span class="type-annotation"><a href="../creator/Field-class.html">Field</a></span> <span class="parameter-name">field</span></span>)
    <span class="returntype parameter">&#8594; <a href="https://api.flutter.dev/flutter/widgets/TextEditingController-class.html">TextEditingController</a></span>
  </span>
  

</dt>
<dd>
  Get the <a href="https://api.flutter.dev/flutter/widgets/TextEditingController-class.html">TextEditingController</a> for a particular field.
  

</dd>

        <dt id="getLockedNotifier" class="callable">
  <span class="name"><a href="../models/CreatorModel/getLockedNotifier.html">getLockedNotifier</a></span><span class="signature">(<wbr><span class="parameter" id="getLockedNotifier-param-field"><span class="type-annotation"><a href="../creator/Field-class.html">Field</a></span> <span class="parameter-name">field</span></span>)
    <span class="returntype parameter">&#8594; <a href="https://api.flutter.dev/flutter/foundation/ValueNotifier-class.html">ValueNotifier</a><span class="signature">&lt;<wbr><span class="type-parameter"><a href="https://api.flutter.dev/flutter/dart-core/bool-class.html">bool</a></span>&gt;</span></span>
  </span>
  

</dt>
<dd>
  Get the <a href="https://api.flutter.dev/flutter/foundation/ValueNotifier-class.html">ValueNotifier</a> for a particular field.
  

</dd>

        <dt id="initialise" class="callable">
  <span class="name"><a href="../models/CreatorModel/initialise.html">initialise</a></span><span class="signature">(<wbr>)
    <span class="returntype parameter">&#8594; void</span>
  </span>
  

</dt>
<dd>
  Prepare the <a href="../models/CreatorModel-class.html">CreatorModel</a>'s final variables for use.
  

</dd>

        <dt id="isLocked" class="callable">
  <span class="name"><a href="../models/CreatorModel/isLocked.html">isLocked</a></span><span class="signature">(<wbr><span class="parameter" id="isLocked-param-field"><span class="type-annotation"><a href="../creator/Field-class.html">Field</a></span> <span class="parameter-name">field</span></span>)
    <span class="returntype parameter">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/bool-class.html">bool</a></span>
  </span>
  

</dt>
<dd>
  Whether or not a field is locked and should not be cleared on export.
  

</dd>

        <dt id="noSuchMethod" class="callable inherited">
  <span class="name"><a href="https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html">noSuchMethod</a></span><span class="signature">(<wbr><span class="parameter" id="noSuchMethod-param-invocation"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/Invocation-class.html">Invocation</a></span> <span class="parameter-name">invocation</span></span>)
    <span class="returntype parameter">&#8594; dynamic</span>
  </span>
  

</dt>
<dd class="inherited">
  Invoked when a nonexistent method or property is accessed.
  <div class="features"><span class="feature">inherited</span></div>

</dd>

        <dt id="notifyListeners" class="callable inherited">
  <span class="name"><a href="https://api.flutter.dev/flutter/foundation/ChangeNotifier/notifyListeners.html">notifyListeners</a></span><span class="signature">(<wbr>)
    <span class="returntype parameter">&#8594; void</span>
  </span>
  

</dt>
<dd class="inherited">
  Call all the registered listeners.
  <div class="features"><span class="feature">inherited</span></div>

</dd>

        <dt id="refresh" class="callable">
  <span class="name"><a href="../models/CreatorModel/refresh.html">refresh</a></span><span class="signature">(<wbr>)
    <span class="returntype parameter">&#8594; void</span>
  </span>
  

</dt>
<dd>
  Refresh state for the Card Creator.
  

</dd>

        <dt id="removeListener" class="callable inherited">
  <span class="name"><a href="https://api.flutter.dev/flutter/foundation/ChangeNotifier/removeListener.html">removeListener</a></span><span class="signature">(<wbr><span class="parameter" id="removeListener-param-listener"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-ui/VoidCallback.html">VoidCallback</a></span> <span class="parameter-name">listener</span></span>)
    <span class="returntype parameter">&#8594; void</span>
  </span>
  

</dt>
<dd class="inherited">
  Remove a previously registered closure from the list of closures that are
notified when the object changes.
  <div class="features"><span class="feature">inherited</span></div>

</dd>

        <dt id="setSentenceAndCloze" class="callable">
  <span class="name"><a href="../models/CreatorModel/setSentenceAndCloze.html">setSentenceAndCloze</a></span><span class="signature">(<wbr><span class="parameter" id="setSentenceAndCloze-param-selection"><span class="type-annotation"><a href="../utils/JidoujishoTextSelection-class.html">JidoujishoTextSelection</a></span> <span class="parameter-name">selection</span></span>)
    <span class="returntype parameter">&#8594; void</span>
  </span>
  

</dt>
<dd>
  Set the sentence and cloze fields with a new selection.
  

</dd>

        <dt id="toggleLock" class="callable">
  <span class="name"><a href="../models/CreatorModel/toggleLock.html">toggleLock</a></span><span class="signature">(<wbr><span class="parameter" id="toggleLock-param-field"><span class="type-annotation"><a href="../creator/Field-class.html">Field</a></span> <span class="parameter-name">field</span></span>)
    <span class="returntype parameter">&#8594; void</span>
  </span>
  

</dt>
<dd>
  Get the <a href="https://api.flutter.dev/flutter/widgets/TextEditingController-class.html">TextEditingController</a> for a particular field.
  

</dd>

        <dt id="toString" class="callable inherited">
  <span class="name"><a href="https://api.flutter.dev/flutter/dart-core/Object/toString.html">toString</a></span><span class="signature">(<wbr>)
    <span class="returntype parameter">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/String-class.html">String</a></span>
  </span>
  

</dt>
<dd class="inherited">
  A string representation of this object.
  <div class="features"><span class="feature">inherited</span></div>

</dd>

    </dl>
  </section>
    
  <section
      class="summary offset-anchor inherited"
      id="operators">
    <h2>Operators</h2>
    <dl class="callables">
        <dt id="operator ==" class="callable inherited">
  <span class="name"><a href="https://api.flutter.dev/flutter/dart-core/Object/operator_equals.html">operator ==</a></span><span class="signature">(<wbr><span class="parameter" id="==-param-other"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/Object-class.html">Object</a></span> <span class="parameter-name">other</span></span>)
    <span class="returntype parameter">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/bool-class.html">bool</a></span>
  </span>
  

</dt>
<dd class="inherited">
  The equality operator.
  <div class="features"><span class="feature">inherited</span></div>

</dd>

    </dl>
  </section>
    
    
    


  </div> <!-- /.main-content -->

  <div id="dartdoc-sidebar-left" class="sidebar sidebar-offcanvas-left">
    <header id="header-search-sidebar" class="hidden-l">
  <form class="search-sidebar" role="search">
    <input type="text" id="search-sidebar" autocomplete="off" disabled class="form-control typeahead" placeholder="Loading search...">
  </form>
</header>

<ol class="breadcrumbs gt-separated dark hidden-l" id="sidebar-nav">
  <li><a href="../index.html">yuuna</a></li>
  <li><a href="../models/models-library.html">models</a></li>
  <li class="self-crumb">CreatorModel class</li>
</ol>


    <h5>models library</h5>
    <ol>
      <li class="section-title"><a href="../models/models-library.html#classes">Classes</a></li>
        <li><a href="../models/AppModel-class.html">AppModel</a></li>
        <li><a href="../models/CreatorModel-class.html">CreatorModel</a></li>




      <li class="section-title"><a href="../models/models-library.html#properties">Properties</a></li>
        <li><a href="../models/appProvider.html">appProvider</a></li>
        <li><a href="../models/creatorProvider.html">creatorProvider</a></li>
        <li><a href="../models/fieldsByKey.html">fieldsByKey</a></li>
        <li><a href="../models/globalFields.html">globalFields</a></li>
        <li><a href="../models/globalSchemas.html">globalSchemas</a></li>
        <li><a href="../models/instantExportProvider.html">instantExportProvider</a></li>
        <li><a href="../models/pipSearchPositionProvider.html">pipSearchPositionProvider</a></li>
        <li><a href="../models/pipSearchResultProvider.html">pipSearchResultProvider</a></li>
        <li><a href="../models/pipSearchTermProvider.html">pipSearchTermProvider</a></li>
        <li><a href="../models/quickActionColorProvider.html">quickActionColorProvider</a></li>
        <li><a href="../models/visibleOnceProvider.html">visibleOnceProvider</a></li>




</ol>

  </div>

  <div id="dartdoc-sidebar-right" class="sidebar sidebar-offcanvas-right">
    <ol>

        <li class="section-title"><a href="../models/CreatorModel-class.html#constructors">Constructors</a></li>
          <li><a href="../models/CreatorModel/CreatorModel.html">CreatorModel</a></li>


        <li class="section-title">
          <a href="../models/CreatorModel-class.html#instance-properties">Properties</a>
        </li>
          <li><a href="../models/CreatorModel/controllersByField.html">controllersByField</a></li>
          <li class="inherited"><a href="https://api.flutter.dev/flutter/dart-core/Object/hashCode.html">hashCode</a></li>
          <li class="inherited"><a href="https://api.flutter.dev/flutter/foundation/ChangeNotifier/hasListeners.html">hasListeners</a></li>
          <li class="inherited"><a href="https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html">runtimeType</a></li>
          <li><a href="../models/CreatorModel/scrollController.html">scrollController</a></li>

        <li class="section-title"><a href="../models/CreatorModel-class.html#instance-methods">Methods</a></li>
          <li class="inherited"><a href="https://api.flutter.dev/flutter/foundation/ChangeNotifier/addListener.html">addListener</a></li>
          <li><a href="../models/CreatorModel/appendSentenceAndCloze.html">appendSentenceAndCloze</a></li>
          <li><a href="../models/CreatorModel/clearAll.html">clearAll</a></li>
          <li><a href="../models/CreatorModel/clearField.html">clearField</a></li>
          <li><a href="../models/CreatorModel/copyContext.html">copyContext</a></li>
          <li class="inherited"><a href="https://api.flutter.dev/flutter/foundation/ChangeNotifier/dispose.html">dispose</a></li>
          <li><a href="../models/CreatorModel/getExportDetails.html">getExportDetails</a></li>
          <li><a href="../models/CreatorModel/getFieldController.html">getFieldController</a></li>
          <li><a href="../models/CreatorModel/getLockedNotifier.html">getLockedNotifier</a></li>
          <li><a href="../models/CreatorModel/initialise.html">initialise</a></li>
          <li><a href="../models/CreatorModel/isLocked.html">isLocked</a></li>
          <li class="inherited"><a href="https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html">noSuchMethod</a></li>
          <li class="inherited"><a href="https://api.flutter.dev/flutter/foundation/ChangeNotifier/notifyListeners.html">notifyListeners</a></li>
          <li><a href="../models/CreatorModel/refresh.html">refresh</a></li>
          <li class="inherited"><a href="https://api.flutter.dev/flutter/foundation/ChangeNotifier/removeListener.html">removeListener</a></li>
          <li><a href="../models/CreatorModel/setSentenceAndCloze.html">setSentenceAndCloze</a></li>
          <li><a href="../models/CreatorModel/toggleLock.html">toggleLock</a></li>
          <li class="inherited"><a href="https://api.flutter.dev/flutter/dart-core/Object/toString.html">toString</a></li>

        <li class="section-title inherited"><a href="../models/CreatorModel-class.html#operators">Operators</a></li>
          <li class="inherited"><a href="https://api.flutter.dev/flutter/dart-core/Object/operator_equals.html">operator ==</a></li>




</ol>

  </div><!--/.sidebar-offcanvas-->

</main>

<footer>
  <span class="no-break">
    yuuna
      2.8.0+93
  </span>

  
</footer>



<script src="../static-assets/highlight.pack.js?v1"></script>
<script src="../static-assets/docs.dart.js"></script>



</body>

</html>

